run e2e test in github actions #1004
Conversation
WalkthroughThe project has integrated a new GitHub Actions workflow specifically designed for end-to-end (e2e) testing, coverage analysis, and the build process. This workflow is triggered by pull requests targeting specific directories and by pushes to the main branch or branches matching the pattern 'wl/**'. It ensures concurrency control and consists of two jobs: 'setup' for setting up the environment and 'build_and_test' for building and testing the e2e components. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (1)
- .github/workflows/e2e-test-coverage.yml (1 hunks)
Additional comments: 8
.github/workflows/e2e-test-coverage.yml (8)
- 1-15: The workflow is correctly triggered by pull requests and push events to the main branch or branches matching 'wl/**', and it targets the appropriate directories for e2e tests.
- 17-21: Concurrency settings are well-defined to ensure only a single instance of the workflow runs at a time, which is a good practice to avoid redundant runs and save resources.
- 24-29: The 'setup' job is configured to run on the latest Ubuntu runner and sets the working directory to
./e2e-testing, which is appropriate for the context.- 31-33: The repository is checked out using the latest version of
actions/checkout, which is a standard and recommended practice.- 35-38: Node.js is installed using the
actions/setup-node@v3action, with a specified version of 16. This ensures consistency across runs.- 44-45: Docker Buildx is set up using the
docker/setup-buildx-action@v1action, which is standard for Docker workflows.- 60-65: The 'build_and_test' job is set to run after the 'setup' job completes, which is a good practice to ensure dependencies are ready. It also correctly sets the working directory.
- 67-71: The 'Build and Test' step is concise and clear, running the build and test commands using
pnpm. Ensure that thepnpm testcommand is correctly set up to run the e2e tests.
| - name: Install pnpm | ||
| run: | ||
| npm install -g [email protected] |
There was a problem hiding this comment.
The installation of pnpm is done globally, which is acceptable, but the version is hardcoded. Consider using a variable or a strategy to manage the version to make updates easier in the future.
- npm install -g [email protected]
+ npm install -g pnpm@${{ env.PNPM_VERSION }}Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| - name: Install pnpm | |
| run: | |
| npm install -g pnpm@6.34.0 | |
| - name: Install pnpm | |
| run: | |
| npm install -g pnpm@${{ env.PNPM_VERSION }} |
| - name: Build and install Indexer | ||
| run: | | ||
| pnpm install --loglevel warn --frozen-lockfile | ||
| pnpm run build:all | ||
| working-directory: ./indexer |
There was a problem hiding this comment.
The 'Build and install Indexer' step has a misaligned run keyword, which will cause a syntax error in the YAML file. This needs to be corrected for the workflow to function.
- run: |
+ run: |Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| - name: Build and install Indexer | |
| run: | | |
| pnpm install --loglevel warn --frozen-lockfile | |
| pnpm run build:all | |
| working-directory: ./indexer | |
| - name: Build and install Indexer | |
| run: | | |
| pnpm install --loglevel warn --frozen-lockfile | |
| pnpm run build:all | |
| working-directory: ./indexer |
| - name: Build and Start Docker Compose | ||
| run: | | ||
| cd ../protocol | ||
| make e2etest-build-image | ||
| cd ../e2e-testing | ||
| docker compose -f docker-compose-e2e-test.yml up -d |
There was a problem hiding this comment.
The 'Build and Start Docker Compose' step correctly builds the Docker image and starts the services using Docker Compose. However, the use of cd to change directories is not necessary and can be replaced with the working-directory option for consistency.
- cd ../protocol
- make e2etest-build-image
- cd ../e2e-testing
- docker compose -f docker-compose-e2e-test.yml up -d
+ run: make e2etest-build-image
+ working-directory: ./protocol
+ run: docker compose -f docker-compose-e2e-test.yml up -d
+ working-directory: ./e2e-testingCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| - name: Build and Start Docker Compose | |
| run: | | |
| cd ../protocol | |
| make e2etest-build-image | |
| cd ../e2e-testing | |
| docker compose -f docker-compose-e2e-test.yml up -d | |
| - name: Build and Start Docker Compose | |
| run: make e2etest-build-image | |
| working-directory: ./protocol | |
| run: docker compose -f docker-compose-e2e-test.yml up -d | |
| working-directory: ./e2e-testing |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to path filters (1)
e2e-testing/docker-compose-e2e-test-remote.ymlis excluded by:!**/*.yml
Files selected for processing (1)
- .github/workflows/e2e-test-coverage.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/e2e-test-coverage.yml
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to path filters (1)
e2e-testing/docker-compose-e2e-test-remote.ymlis excluded by:!**/*.yml
Files selected for processing (1)
- .github/workflows/e2e-test-coverage.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/e2e-test-coverage.yml
Changelist
run e2e test in github actions
Test Plan
[Describe how this PR was tested (if applicable)]
Author/Reviewer Checklist
state-breakinglabel.indexer-postgres-breakinglabel.PrepareProposalorProcessProposal, manually add the labelproposal-breaking.feature:[feature-name].backport/[branch-name].refactor,chore,bug.